API Documentation
Static Public Member Functions | List of all members
nkAstraeus::lua::nkGraphicsWrap::CameraWrapper Class Referencefinal

Wraps a nkGraphics::Camera and offers functions for use in scripting. More...

Static Public Member Functions

static void updateEnvironment (nkScripts::Environment *env)
 
static nkScripts::OutputValue getPositionAbsolute (const nkScripts::DataStack &stack)
 
static nkScripts::OutputValue getFrustum (const nkScripts::DataStack &stack)
 
static nkScripts::OutputValue getFov (const nkScripts::DataStack &stack)
 

Detailed Description

Wraps a nkGraphics::Camera and offers functions for use in scripting.

Member Function Documentation

◆ updateEnvironment()

static void nkAstraeus::lua::nkGraphicsWrap::CameraWrapper::updateEnvironment ( nkScripts::Environment env)
static

Updates a given environment and set it up to use all functions wrapped by this wrapper.

Parameters
envThe environment to set up.

◆ getPositionAbsolute()

static nkScripts::OutputValue nkAstraeus::lua::nkGraphicsWrap::CameraWrapper::getPositionAbsolute ( const nkScripts::DataStack stack)
static

Wrapper function for the nkGraphics::Camera::getPositionAbsolute().

local p = c:getPositionAbsolute() ;
Parameters
stackThe data from which the attribute will be retrieved.
Returns
The attribute value, as a nkGraphics::Vector.

◆ getFrustum()

static nkScripts::OutputValue nkAstraeus::lua::nkGraphicsWrap::CameraWrapper::getFrustum ( const nkScripts::DataStack stack)
static

Wrapper function for the nkGraphics::Camera::getFrustum().

local f = c:getFrustum() ;
Parameters
stackThe data from which the attribute will be retrieved.
Returns
The attribute value, as a nkGraphics::Frustum.

◆ getFov()

static nkScripts::OutputValue nkAstraeus::lua::nkGraphicsWrap::CameraWrapper::getFov ( const nkScripts::DataStack stack)
static

Wrapper function for the nkGraphics::Camera::getFov().

local d = c:getFov() ;
Parameters
stackThe data from which the attribute will be retrieved.
Returns
The attribute value, as a float.

The documentation for this class was generated from the following file: